Sourced from pytest-celery's releases.

v1.0.0 Official Release

User Manual: https://pytest-celery.readthedocs.io/en/latest/
PyPI: https://pypi.org/project/pytest-celery/
Source: https://github.com/celery/pytest-celery/

Install with pip install -U "pytest-celery[all]".

Key Highlights

Simple

The plugin provides a single entry point to the test case and makes sure everything is configured according to the selected architecture and requirements.

By default, all of the supported architecture components are added to a matrix of all possible combinations. Pytest will generate a test case for each combination, and will run it in an isolated environment.

This allows separation of concerns, and makes it simple to access different architectures in a single test case, for example:

def test_hello_world(celery_setup: CeleryTestSetup):
    assert celery_setup.ready()

This code will generate test cases for all possible combinations of the supported brokers and backends, using the latest version of Celery. Under the context of the test, each combination will be available as a celery_setup fixture, with access to all of the required components, and will run in an isolated environment.

Flexible

The plugin is highly configurable, and can be used to test a wide range of Celery architectures. It can be configured to use a specific version of Celery, or to use a specific version of a broker or backend. It can also be configured to use a custom broker or backend, or to use a custom Celery application.

For basic usage, the plugin provides default components that can be configured and extended.

For more advanced use cases, the plugin uses the pytest fixtures mechanism to allow injecting custom components into the environment and build a custom Celery architecture for your project.

For example, see the rabbitmq-management example, which demonstrates how to replace the default broker matrix with a single RabbitMQ Management broker.

Fast

The plugin is designed to run tests in parallel using isolated environments. It supports the pytest-xdist plugin to run tests in parallel and scales well with available resources to improve the overall test suite performance.

Annotated

The codebase is fully annotated with type hints and is tested with mypy to ensure type safety across the board, allowing for a better development experience.

Supports

• Workers

  • Latest Celery version.
  • Custom worker.

• Brokers

... (truncated)

• cab6df7 Prepare for release: v1.0.0 (#286)
• 6591cfd Fixed PyPI README.rst errors that failed the automatic deployment to PyPI (#285)
• 3980846 Prepare for (pre) release: v1.0.0rc4 (#284)
• 419c93b Docs: Added main README documentation (#283)
• d7614ed Updated sponsorship configurations (#282)
• 9f9ec65 Hotfix: Lint error fix (#281)
• 1757a77 Doc: Removed "Documentation under construction!" (#280)
• f561d2d Docs Enhancements (#279)
• 9bd9022 Hotfix: Added gevent extra to built in worker (#278)
• 5fffb62 Build(deps-dev): Bump types-redis from 4.6.0.20240311 to 4.6.0.20240409 (#277)
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)